home *** CD-ROM | disk | FTP | other *** search
/ Game Programming in C++ - Start to Finish / GameProgrammingS.iso / developer_install / CEGUISDK-0.4.1-VC6-Native.exe / {app} / include / elements / CEGUITitlebarProperties.h < prev    next >
Encoding:
C/C++ Source or Header  |  2005-01-18  |  3.0 KB  |  99 lines
  1. /************************************************************************
  2.     filename:     CEGUITitlebarProperties.h
  3.     created:    10/7/2004
  4.     author:        Paul D Turner
  5.     
  6.     purpose:    Interface for title bar property classes
  7. *************************************************************************/
  8. /*************************************************************************
  9.     Crazy Eddie's GUI System (http://www.cegui.org.uk)
  10.     Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
  11.  
  12.     This library is free software; you can redistribute it and/or
  13.     modify it under the terms of the GNU Lesser General Public
  14.     License as published by the Free Software Foundation; either
  15.     version 2.1 of the License, or (at your option) any later version.
  16.  
  17.     This library is distributed in the hope that it will be useful,
  18.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  19.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20.     Lesser General Public License for more details.
  21.  
  22.     You should have received a copy of the GNU Lesser General Public
  23.     License along with this library; if not, write to the Free Software
  24.     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  25. *************************************************************************/
  26. #ifndef _CEGUITitlebarProperties_h_
  27. #define _CEGUITitlebarProperties_h_
  28.  
  29. #include "CEGUIProperty.h"
  30.  
  31.  
  32. // Start of CEGUI namespace section
  33. namespace CEGUI
  34. {
  35.  
  36. // Start of TitlebarProperties namespace section
  37. /*!
  38. \brief
  39.     Namespace containing all classes that make up the properties interface for the Titlebar class
  40. */
  41. namespace TitlebarProperties
  42. {
  43. /*!
  44. \brief
  45.     Property to access the state of the dragging enabled setting for the Titlebar.
  46.  
  47.     \par Usage:
  48.         - Name: DraggingEnabled
  49.         - Format: "[text]".
  50.  
  51.     \par Where [Text] is:
  52.         - "True" to indicate that drag moving is enabled.
  53.         - "False" to indicate that drag moving is disabled.
  54. */
  55. class DraggingEnabled : public Property
  56. {
  57. public:
  58.     DraggingEnabled() : Property(
  59.         "DraggingEnabled",
  60.         "Property to get/set the state of the dragging enabled setting for the Titlebar.  Value is either \"True\" or \"False\".",
  61.         "True")
  62.     {}
  63.  
  64.     String    get(const PropertyReceiver* receiver) const;
  65.     void    set(PropertyReceiver* receiver, const String& value);
  66. };
  67.  
  68.  
  69. /*!
  70. \brief
  71.     Property to colour used for rendering the caption text.
  72.  
  73.     \par Usage:
  74.         - Name: CaptionColour
  75.         - Format: "aarrggbb".
  76.  
  77.     \par Where:
  78.         - aarrggbb is the ARGB colour value to be used.
  79. */
  80. class CaptionColour : public Property
  81. {
  82. public:
  83.     CaptionColour() : Property(
  84.         "CaptionColour",
  85.         "Property to get/set the colour used for rendering the caption text.  Value is \"aarrggbb\" (hex).",
  86.         "FF000000")
  87.     {}
  88.  
  89.     String    get(const PropertyReceiver* receiver) const;
  90.     void    set(PropertyReceiver* receiver, const String& value);
  91. };
  92.  
  93. } // End of  TitlebarProperties namespace section
  94.  
  95. } // End of  CEGUI namespace section
  96.  
  97.  
  98. #endif    // end of guard _CEGUITitlebarProperties_h_
  99.